Assign Consentless Lead to Channel

This request enables a channel to assign a consentless lead to their channel. As a result, the customer does not need to provide consent to partner their preferred operator in their Teams admin center. In addition, the 'Size' and 'Market' parameters are not populated for the lead generation.

●

Make sure that you have added a channel to the Live Platform before proceeding (see Add Channel).

URI

Copy

{{baseUrl}}/api/v3/ovoc/channel/action/assign

HTTP Method

PUT

Request Body

Specify one of the following values:

■

leadMsTenantId

■

leadId

■

umpCustomerGuid

Parameter	Type	Description
leadMsTenantId	string	Microsoft Azure Tenant subscription Id of the customer lead.
leadId	string	The 'id' field retrieved from the Get Leads request (see Get All OC Leads).
umpCustomerGuid	string ($uuid)	This id 'umpCustomerGuid' is created in the Live Platform database for the customer tenant when a Live Platform license is applied. If this field is null, a license has not yet been applied to the lead. This value is also retrieved using Get Services Brief Details (V3) and Get Customers Brief Details (V2). This value is also obtained in the 'Get Task' response when the customer is created.
ChannelId	integer	The Id of the channel to attach the lead. Retrieve this value using Get List of Channels.

Example Request

Copy

 {
  "leadMsTenantId": "a1a1f1aa-e7c1-4ffc-81e3-7b98e119324a",
  "ChannelId": "1315936"
  }

Example Response

Copy

{
    "status": "success",
    "succeeded": true,
    "message": "Lead successfully assigned to the channel"
}

HTTP Responses

■

200 OK

Parameter

Type

Description

status

One of the following values:

■

Success

■

Failed

succeeded

boolean

■

True: Channel lead is successfully assigned

■

False. Channel lead is not assigned

Indicates if the lead has been successfully assigned to a channel.

message

string

Information message for the action.

■

400 Bad Request: The following error is displayed when the lead already exists in the Live Platform database.

Copy

{
    "errors": {
        "TenantId": [
            "This MsTenant already exists as an UMP lead!"
        ]
    },
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-7e087ecc069b2bb6b8edb9b675a1a744-a65210e22368ff22-00"
}

■

403 Forbidden

■

500 Server Error:

●

The following error is displayed when the Microsoft Tenant is not active.

Copy

{
    "title": "MsTenant 'f889d778-d028-49e0-8056-b5d24abb7ca7' is not active.",
    "status": 500,
    "detail": "ErrorTicket=349d1b99-d688-4a4a-a9da-bdbcb10fffbe"
}

●

The following error is displayed when an incorrect tenant Id is entered or when the customer has already been created for the tenant.

Copy

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
    "title": "Failed to assign channel: ",
    "status": 500,
    "detail": "Lead not found.",
    "traceId": "00-4775720d3a1bae96f4cb21a7cb22ba80-90afde65fe7ba490-00"
}